Mappedin Android SDK/com.mappedin.sdk.web/MPIOptions/Path

Path

@Serializable
data class Path @JvmOverloads constructor(    val color: String? = "#4b90e2",     var pulseColor: String? = "#ffffff",     var nearRadius: Double? = 1.8,     var farRadius: Double? = null,     var drawDuration: Double? = 1500.0,     var drawConnectionSegments: Boolean? = null,     var pulseIterations: Double? = null,     var connectionPathOptions: MPIOptions.ConnectionPath? = null,     var displayArrowsOnPath: Boolean? = true,     var interactive: Boolean? = false,     var animateDrawing: Boolean? = true,     var farZoom: Double = 10000.0,     var flattenPath: Boolean = false,     var nearZoom: Double = 375.0,     var pulsePauseDuration: Double = 750.0,     var showPulse: Boolean = true)

Path holds the properties of values to be set when path is drawn

Constructors

Link copied to clipboard
@JvmOverloads
constructor(    color: String? = "#4b90e2",     pulseColor: String? = "#ffffff",     nearRadius: Double? = 1.8,     farRadius: Double? = null,     drawDuration: Double? = 1500.0,     drawConnectionSegments: Boolean? = null,     pulseIterations: Double? = null,     connectionPathOptions: MPIOptions.ConnectionPath? = null,     displayArrowsOnPath: Boolean? = true,     interactive: Boolean? = false,     animateDrawing: Boolean? = true,     farZoom: Double = 10000.0,     flattenPath: Boolean = false,     nearZoom: Double = 375.0,     pulsePauseDuration: Double = 750.0,     showPulse: Boolean = true)

Properties

Link copied to clipboard
var animateDrawing: Boolean?

Animate the drawing of the path in the direction of travel.

Link copied to clipboard
val color: String?

Color of the path drawn

Link copied to clipboard
var connectionPathOptions: MPIOptions.ConnectionPath?

Set properties for connection path when using stacked maps

Link copied to clipboard
var displayArrowsOnPath: Boolean?

Whether to display arrow on path drawn

Link copied to clipboard
var drawConnectionSegments: Boolean?

Whether to draw connection segments

Link copied to clipboard
var drawDuration: Double?

Duration of drawing

Link copied to clipboard
var farRadius: Double?

Far radius of the path drawn (in meters since V4). Default value is 2.3 times nearRadius.

Link copied to clipboard
var farZoom: Double

Zoom level when the path radius should be the value of farRadius.

Link copied to clipboard
var flattenPath: Boolean

Flatten the path to a 2D line

Link copied to clipboard
var interactive: Boolean?

Whether the path should be clickable.

Link copied to clipboard
var nearRadius: Double?

Near radius of the path drawn (in meters since V4)

Link copied to clipboard
var nearZoom: Double

Zoom level where the path size is nearRadius

Link copied to clipboard
var pulseColor: String?

Pulse color of the path drawn

Link copied to clipboard
var pulseIterations: Double?

Set the pulse interations

Link copied to clipboard
var pulsePauseDuration: Double

How many milliseconds to wait before starting the next pulse after the current pulse travels the entirety of the path.

Link copied to clipboard
var showPulse: Boolean

Show an animated pulse indicating the direction of travel.